Skip to main content

Replacement Variables

Replacement variables are dynamic placeholders used in templates to automatically insert personalized or system-generated data. In software like OpsAdmin, these variables are essential for automating contracts, emails, documents, and data exports without manually entering customer- or plan-specific information.


🔧 What They Do:​

Replacement variables are enclosed in brackets like [CUSTOMER_NAME] or [PLAN_RATE_CENTS]. When a template is generated (e.g., a contract or email), the system replaces these variables with actual data from the database.


🧩 Common Use Cases:​

  • Contracts: Automatically insert customer name, address, rate, or term.
  • Emails: Personalize messages using fields like [CUSTOMER_FIRST_NAME].
  • Plan Templates: Dynamically populate pricing, cancellation fees, or utility details.
  • Affiliate & Agent Tools: Show specific commission rates or codes.

🛠️ Example:​

If your contract template says:

"Welcome, [CUSTOMER_NAME]. Your selected rate is [PLAN_RATE_CENTS]¢/kWh."

And the data is:

  • CUSTOMER_NAME: Jane Doe
  • PLAN_RATE_CENTS: 9.7

The final output will be:

"Welcome, Jane Doe. Your selected rate is 9.7¢/kWh."


Full List of Replacement Values:​

CategoryField NameVariableExampleDescription
CustomerContact NameCUSTOMER_CONTACT_NAMEJohn SmithPrimary contact person for the customer.
CustomerCustomer Accepts Being Called By PhoneCUSTOMER_ACCEPTS_BEING_CALLED_BY_PHONEYesIndicates if the customer allows phone calls.
CustomerCustomer Accepts Being Texted Via SmsCUSTOMER_ACCEPTS_BEING_TEXTED_VIA_SMSNoIndicates if the customer allows SMS texts.
CustomerCustomer Alt. PhoneCUSTOMER_ALT_PHONE555-222-3333Secondary phone number.
CustomerCustomer NameENROLL_CUSTOMER_NAMEJane DoeFull name of the enrolling customer.
CustomerCustomer NameCUSTOMER_NAMEJane DoeGeneral customer full name field.
CustomerCustomer TitleCUSTOMER_TITLEMr. / Ms. / Dr.Customer’s preferred title.
CustomerCustomer's method of contactCUSTOMER_METHOD_CONTACTEmailPreferred contact method.
CustomerDisable Bank Account Transactions DateCUSTOMER_DISABLED_BANK..see full2025-01-15Date when ACH/bank payments are disabled.
CustomerEmail AddressENROLL_CUSTOMER_EMAILjane@email.comEmail used for enrollment.
CustomerEmail AddressCUSTOMER_EMAILjane@email.comGeneral customer email field.
CustomerFirst NameFIRST_NAMEJaneCustomer’s first name.
CustomerLast NameLAST_NAMEDoeCustomer’s last name.
CustomerPhone NumberENROLL_CUSTOMER_PHONE555-444-1212Phone used for enrollment.
CustomerPhone NumberCUSTOMER_PHONE555-444-1212General customer phone.
AddressBilling City NameBILLING_CITY_NAMEHoustonBilling address city.
AddressBilling Ln1 AddressBILLING_LN1_ADDR123 Main St.First line of billing address.
AddressBilling Ln2 AddressBILLING_LN2_ADDRApt 4BSecond line of billing address.
AddressBilling Postal CodeBILLING_POSTAL_CODE77002Billing postal/ZIP code.
AddressBilling State CodeBILLING_STATE_CODETXTwo-letter billing state abbreviation.
AddressBilling State NameBILLING_STATE_NAMETexasFull billing state name.
AddressService City NameSERVICE_CITY_NAMEDallasService address city.
AddressService Ln1 AddressSERVICE_LN1_ADDR456 Oak St.First line of service address.
AddressService Ln2 AddressSERVICE_LN2_ADDRUnit 7Second line of service address.
AddressService Postal CodeSERVICE_POSTAL_CODE75201Service postal/ZIP code.
AddressService State CodeSERVICE_STATE_CODETXTwo-letter service state abbreviation.
AddressService State NameSERVICE_STATE_NAMETexasFull service state name.
Customer TypeARP Customer TypeARP_CUSTOMER_TYPEResidentialCustomer type from ARP data.
Customer TypeCustomer TypeCUSTOMER_TYPECommercialGeneral classification of customer.
Customer TypePlan Customer TypePLAN_CUSTOMER_TYPEResidentialType of customer as it relates to plan.
Company & LinksCompany Authorized Signer EmailCOMPANY_AUTHORIZED_SIGNER_EMAILsigner@email.comEmail for authorized company signer.
Company & LinksCompany Authorized Signer NameCOMPANY_AUTHORIZED_SIGNER_NAMEJohn ExecutiveName of authorized company signer.
Company & LinksCompany Authorized Signer Title NameCOMPANY_AUTHORIZED_SIGNER_TITLE_NAMECFOTitle of the authorized company signer.
Company & LinksCompany Email AddressCOMPANY_EMAIL_ADDRESScompany@email.comGeneral company email address.
Company & LinksCompany PhoneCOMPANY_PHONE555-111-9999General company phone.
Company & LinksCompany Site NameCOMPANY_SITE_NAMEEnergyCo PortalInternal site/portal name.
Company & LinksCompany Site URLCOMPANY_URL_CONTENT_MANAGERhttps://companyportal.comCMS portal URL.
Company & LinksCompany Wizard URLCOMPANY_URL_WIZARDhttps://wizard.company.comEnrollment wizard URL.
Company & LinksCustomer Company NameCOMPANY_NAMEEnergyCo LLCCustomer’s company name.
Company & LinksCustomer Restore Password URLURL_CUSTOMER_RESTORE_PASSWORDhttps://myaccount/resetLink for customer to reset password.
Company & LinksFrontEnd Site URLSITE_URLhttps://frontend.company.comFrontend site URL.
Company & LinksMyAccount Site URLURL_CUSTOMER_MYACCOUNThttps://myaccount.company.comLink to customer self-service portal.
Company & LinksRenewals Wizard UrlRENEWAL_WIZARD_URLhttps://renew.company.comURL for renewals enrollment wizard.
AffiliateAffiliate Agent CodeAFF_AGENT_CODEAGT-204Code identifying the affiliate’s agent.
AffiliateAffiliate Comission 2 End DateAFF_COMISSION_2_END_DATE2025-12-31End date for the secondary commission schedule.
AffiliateAffiliate Comission 2 PlanAFF_COMISSION_2_PLANGreenSaver12Plan tied to the secondary commission.
AffiliateAffiliate Comission 2 Start DateAFF_COMISSION_2_START_DATE2025-01-01Start date for the secondary commission schedule.
AffiliateAffiliate Comission CodeAFF_COMISSION_CODECOM-992Code for the affiliate commission arrangement.
AffiliateAffiliate Comission End DateAFF_COMISSION_END_DATE2025-06-30End date for the primary commission schedule.
AffiliateAffiliate Comission PlanAFF_COMISSION_PLANEcoFixed24Plan tied to the primary commission.
AffiliateAffiliate Comission Start DateAFF_COMISSION_START_DATE2025-01-01Start date for the primary commission schedule.
AffiliateAffiliate Master CodeAFF_MASTER_CODEAFF-MASTER-01Master tracking code for the affiliate.
AffiliateAffiliate NameAFF_NAMEEcoPartnersAffiliate organization name.
AffiliateAffiliate Promo CodeAFF_PROMO_CODESAVE50Promo/discount code used by the affiliate.
AffiliatePromo Code MessagePROMO_CODE_MESSAGEUse code SAVE50…Message text shown with the promo code.
UtilityDistributor NameDISTRIBUTOR_NAMECenterPointLocal distribution company name.
UtilityEmergency NumberUTILITY_EMERGENCY_NUMBER800-555-1212Utility emergency contact number.
UtilityMarket Choose SiteMARKET_CHOOSE_SITEhttps://papowerswitch.comMarket “choose your provider” site.
UtilityMarket Goverment SiteMARKET_GOVSITEhttps://puc.texas.govMarket/government regulator site.
UtilityMarket StateMARKET_STATETXMarket state abbreviation.
UtilityMarket Utility Commission NameMARKET_UTILITY_COMMISSION_NAMEPublic Utility Commission…Commission/regulator’s formal name.
UtilityT&D Additional Residential Usage Credit ChargeTD_ADDITIONAL_RESIDENTIAL_USAGE_CREDIT_CHARGE-$0.012/kWhAdditional usage credit amount.
UtilityT&D Additional Residential Usage Credit KwH RangeTD_ADDITIONAL_RESIDENTIAL_USAGE_CREDIT_RANGE1000–2000 kWhkWh range for additional usage credit.
UtilityT&D Additional Residential Usage Credit NameTD_ADDITIONAL_RESIDENTIAL_USAGE_CREDIT_NAMEAdditional Usage CreditLabel/name for the credit.
UtilityT&D Minimum Usage Fee ChargeTD_MINIMUM_USAGE_FEE_CHARGE$9.95Minimum usage fee amount.
UtilityT&D Minimum Usage Fee KwH RangeTD_MINIMUM_USAGE_FEE_RANGE0–500 kWhkWh range for minimum usage fee applicability.
UtilityT&D Minimum Usage Fee NameTD_MINIMUM_USAGE_FEE_NAMEMinimum Usage FeeLabel/name for the fee.
UtilityT&D Price to Compare Tier 1 ChargeTD_PRICE_TO_COMPARE_TIER_1_CHARGE$0.12/kWhTier 1 “price to compare” charge.
UtilityT&D Price to Compare Tier 1 KwH RangeTD_PRICE_TO_COMPARE_TIER_1_RANGE0–500 kWhTier 1 kWh range.
UtilityT&D Price to Compare Tier 1 NameTD_PRICE_TO_COMPARE_TIER_1_NAMEPTC Tier 1Tier 1 label.
UtilityT&D Price to Compare Tier 2 ChargeTD_PRICE_TO_COMPARE_TIER_2_CHARGE$0.14/kWhTier 2 “price to compare” charge.
UtilityT&D Price to Compare Tier 2 KwH RangeTD_PRICE_TO_COMPARE_TIER_2_RANGE501–1000 kWhTier 2 kWh range.
UtilityT&D Price to Compare Tier 2 NameTD_PRICE_TO_COMPARE_TIER_2_NAMEPTC Tier 2Tier 2 label.
UtilityT&D Residential Usage Credit ChargeTD_RESIDENTIAL_USAGE_CREDIT_CHARGE-$0.010/kWhResidential usage credit amount.
UtilityT&D Residential Usage Credit KwH RangeTD_RESIDENTIAL_USAGE_CREDIT_RANGE0–1000 kWhResidential usage credit range.
UtilityT&D Residential Usage Credit NameTD_RESIDENTIAL_USAGE_CREDIT_NAMEUsage CreditLabel for the residential usage credit.
UtilityUtilityPLAN_UTILITYPPLUtility code/name tied to the plan.
UtilityUtility Address 1UTILITY_ADDRESS_1100 Main StUtility mailing address line 1.
UtilityUtility Address 2UTILITY_ADDRESS_2Suite 200Utility mailing address line 2.
UtilityUtility CityUTILITY_CITYAllentownUtility city.
UtilityUtility formal namePLAN_UTILITY_FORMAL_NAMEPPL Electric UtilitiesFormal utility name for disclosures.
UtilityUtility Phone NumberUTILITY_PHONE_NUMBER800-123-4567Utility contact number.
UtilityUtility Price To CompareUTILITY_PRICE_TO_COMPARE$0.115/kWhUtility “price to compare”.
UtilityUtility Price To Compare End DateUTILITY_PRICE_TO_COMPARE_END_DATE2025-09-30PTC effective end date.
UtilityUtility Price To Compare Start DateUTILITY_PRICE_TO_COMPARE_START_DATE2025-07-01PTC effective start date.
UtilityUtility Rescission PeriodUTILITY_RESCISSION_PERIOD3 daysCustomer rescission period in this market.
UtilityUtility StateUTILITY_STATETexasState name for the utility.
UtilityUtility Unit of MeasureUTILITY_UOMkWhUOM used by the utility.
UtilityUtility WebsiteUTILITY_WEBSITEhttps://utility.example.comUtility website.
UtilityUtility_Zip_CodeUTILITY_ZIP_CODE18101Utility postal/ZIP code.
UserCreated byCREATED_BYjsnowUsername/identifier that created the record.
UserModified byMODIFIED_BYariversUsername/identifier that last modified the record.
UserUser Hash codeHASH8c7f1a…System-generated hash (e.g., for unique links).
UserUsernameUSERNAMErmcdoCurrent user’s username.
OtherCredit Check ReasonsCREDIT_CHECK_REASONSThin fileReasons returned from the credit check.
OtherCredit Check ScoreCREDIT_CHECK_SCORE725Credit score returned by check.
OtherExport DateEXPORT_DATE2025-08-01Date a file/record was exported.
OtherOrdinal SuffixORDINAL_SUFFIXthOrdinal suffix helper for dates (e.g., 5th).
OtherPartner AccountPARTNER_ACCOUNTPART-00123Partner account identifier.
OtherToday's DateDATE_TODAY2025-08-19Current date at generation time.
Legal NamesMarketer Legal AddressLEGAL_NAME_ADDRESS123 Legal Ave, Austin, TXLegal address of the marketer.
Legal NamesMarketer Legal Duns1LEGAL_NAME_DUNS112-345-6789First DUNS identifier.
Legal NamesMarketer Legal Duns2LEGAL_NAME_DUNS298-765-4321Second DUNS identifier (if any).
Legal NamesMarketer Legal EmailLEGAL_NAME_EMAILcompliance@stormcrest.comLegal/compliance contact email.
Legal NamesMarketer Legal NameLEGAL_NAME_NAMEStormcrest Energy LLCLegal entity name.
Legal NamesMarketer Legal PhoneLEGAL_NAME_PHONE512-555-0101Legal/compliance phone.
CampaignsCampaign Contract TextCAMPAIGN_CONTRACT_TEXTSpecial offer terms…Contract text snippet for a campaign.
CampaignsCampaign Presentation TextCAMPAIGN_PRESENTATION_TEXTHeadline + bulletsPresentation/marketing copy for campaign.
CommunicationDate to PrintDATE_TO_PRINT2025-08-19Date printed on letters or PDFs.
CommunicationEmail Generation DateEMAIL_GENERATION_DATE2025-08-18Date when an email was generated.
CommunicationEmail Generation MonthEMAIL_GENERATION_MONTH08Month portion of the email generation date.
CommunicationEmail Generation YearEMAIL_GENERATION_YEAR2025Year portion of the email generation date.
CommunicationLetter Generation DateLETTER_GENERATION_DATE2025-08-01Date when a letter was generated.
CommunicationLetter Generation MonthLETTER_GENERATION_MONTH08Month portion of the letter generation date.
CommunicationLetter Generation YearLETTER_GENERATION_YEAR2025Year portion of the letter generation date.
CommunicationOriginal enrollment contract end dateLETTER_ORIGINAL_CONTRACT_END_DATE2026-02-28Original end date of the prior contract (for letters).
Enrollment & CustomerContract Signatory NameCUSTOMER_CONTRACT_SIGNATORY_NAMEJohn A. DoeName of the person signing the contract.
Enrollment & CustomerCustomer Account NumberCUSTOMER_ACCOUNT_NUMBER1234567890Customer’s account number.
Enrollment & CustomerCustomer AddressCUSTOMER_ADDRESS456 Oak StPrimary street address of the customer.
Enrollment & CustomerCustomer Address2CUSTOMER_ADDRESS2Apt 12BSecondary address line.
Enrollment & CustomerCustomer Annual UsageCUSTOMER_ANNUAL_USAGE12,000 kWhEstimated/actual annual energy usage.
Enrollment & CustomerCustomer CityCUSTOMER_CITYDallasCity of residence.
Enrollment & CustomerCustomer EmailCUSTOMER_EMAILjohndoe@email.comCustomer email address.
Enrollment & CustomerCustomer First NameCUSTOMER_FIRST_NAMEJohnCustomer’s first name.
Enrollment & CustomerCustomer Full NameCUSTOMER_FULL_NAMEJohn DoeCustomer’s full legal name.
Enrollment & CustomerCustomer Last NameCUSTOMER_LAST_NAMEDoeCustomer’s last name.
Enrollment & CustomerCustomer Phone NumberCUSTOMER_PHONE_NUMBER214-555-9876Customer’s primary contact number.
Enrollment & CustomerCustomer Service StateCUSTOMER_SERVICE_STATETXState where service is delivered.
Enrollment & CustomerCustomer Service ZipCUSTOMER_SERVICE_ZIP75201Service ZIP code.
Enrollment & CustomerCustomer StateCUSTOMER_STATETexasCustomer’s mailing state.
Enrollment & CustomerCustomer ZipCUSTOMER_ZIP75201Customer’s mailing ZIP code.
Enrollment & CustomerEnrollment IDENROLLMENT_IDENR-45890System enrollment identifier.
Enrollment & CustomerEnrollment StatusENROLLMENT_STATUSPendingStatus of enrollment in workflow.
Enrollment & CustomerEnrollment Submission DateENROLLMENT_SUBMISSION_DATE2025-08-15Date the enrollment was submitted.
Enrollment & CustomerMeter NumberMETER_NUMBER145879302Utility meter number tied to the account.
Enrollment & CustomerService AddressCUSTOMER_SERVICE_ADDRESS789 Pine StAddress where the service is delivered.
Enrollment & CustomerService Address2CUSTOMER_SERVICE_ADDRESS2Unit 2ASecondary service address line.
Enrollment & CustomerService CityCUSTOMER_SERVICE_CITYHoustonCity for the service address.
Enrollment & CustomerService TypeCUSTOMER_SERVICE_TYPEResidentialType of service (Residential/Commercial).
Enrollment & CustomerBilling AddressENROLL_BILLING_ADDRESS123 Main StFull billing street address tied to enrollment.
Enrollment & CustomerBilling zipcodeENROLL_CORRESPONDENCE_ZIPCODE77002ZIP/postal code for billing correspondence.
Enrollment & CustomerContract End DateCONTRACT_END_DATE2026-08-31End date of the customer’s enrollment contract.
Enrollment & CustomerCreated atCREATED_AT2025-08-20Timestamp when the enrollment record was created.
Enrollment & CustomerDays Until End dateDAYS_UNTIL_END_DATE45Number of days remaining until the contract end date.
Enrollment & CustomerEmail Send DateEMAIL_SEND_DATE2025-07-15Date an email was sent to this enrollment/customer.
Enrollment & CustomerEnrollment's method of consentENROLL_METHOD_CONSENTE-SignMethod by which consent was obtained (e.g., Voice, E-Sign, Written).
Enrollment & CustomerEnrollment's Name keyENROLL_NAME_KEYENROLL-2025-001Internal system identifier for enrollment name mapping.
Enrollment & CustomerESG REST - Billing Account NumberBILLING_ACCOUNT_NUMBER456789123Billing account number received from ESG REST API.
Enrollment & CustomerETF Invoice Total AmountTOTAL_AMMOUNT$250.00Total amount billed for early termination fee.
Enrollment & CustomerInvoice DateINVOICE_DATE2025-07-01Date of invoice generated for enrollment.
Enrollment & CustomerLDCENROLLMENT_LDCCONEDLocal Distribution Company code for the enrollment.
Enrollment & CustomerMailing AddressMAILING_ADDRESS987 Hilltop RdCustomer’s mailing street address.
Enrollment & CustomerMailing CityMAILING_CITYHoustonCity for the mailing address.
Enrollment & CustomerMailing Postal CodeMAILING_POSTAL_CODE77055ZIP/postal code for mailing.
Enrollment & CustomerMailing State CodeMAILING_STATE_CODETXState code for the mailing address.
Enrollment & CustomerModified atMODIFIED_AT2025-08-19Timestamp when the record was last modified.
Enrollment & CustomerNotice DateNOTICE_DATE2025-06-20Date when a renewal or contract notice was sent.
Enrollment & CustomerPrevious Enrollment Plan Cancellation FeePREVIOUS_ENROLLMENT_PLAN_ETF$150Cancellation fee from the previous enrollment plan.
Enrollment & CustomerPrevious Enrollment Plan Monthly FeePREVIOUS_ENROLLMENT_PLAN_MONTHLY_FEE$10.95Monthly fee from the previous enrollment plan.
Enrollment & CustomerPrevious Enrollment Plan NamePREVIOUS_ENROLLMENT_PLAN_NAMETexas Saver 12Name of the previous enrollment plan.
Enrollment & CustomerPrevious Enrollment Plan Rate CentsPREVIOUS_ENROLLMENT_PLAN_RATE_CENTS12.5Rate of the previous enrollment plan in cents.
Enrollment & CustomerPrevious Enrollment Plan Rate DollarsPREVIOUS_ENROLLMENT_PLAN_RATE_DOLLARS0.125Rate of the previous enrollment plan in dollars.
Enrollment & CustomerPrevious Enrollment Plan TermPREVIOUS_ENROLLMENT_PLAN_TERM12 monthsContract term length of the previous enrollment.
Enrollment & CustomerPrevious Enrollment Plan TypePREVIOUS_ENROLLMENT_PLAN_TYPEFixedPlan type of the previous enrollment (Fixed, Variable, etc.).
Enrollment & CustomerRecord Update DateRECORD_UPDATE_DATE2025-07-22Date when this enrollment record was updated.
Enrollment & CustomerRenewal Notice 1st Notification DateRENEWAL_FIRST_NOTIF_DATE2025-08-01Date of the first renewal notice sent to the customer.
Enrollment & CustomerRequested Start DateENROLL_REQUESTED_START_DATE2025-09-01Customer’s requested service start date.
Enrollment & CustomerSales DateSALES_DATE2025-06-01Date the enrollment was sold/recorded.
Enrollment & CustomerService End DateENROLL_END_DATE2026-08-31Service contract end date.
Enrollment & CustomerService start dateENROLL_SERVICE_START_DATE2025-09-01Service start date of enrollment.
Enrollment & CustomerService zipcodeENROLL_ZIPCODE77003ZIP/postal code of the service address.
PlanPlan CodePLAN_CODEFIX12-2025Unique code for the plan.
PlanPlan Display NamePLAN_DISPLAY_NAME12-Month FixedMarketing/display name for the plan.
PlanPlan End DatePLAN_END_DATE2026-08-31Date when the plan ends.
PlanPlan Estimated Monthly UsagePLAN_EST_MONTHLY_USAGE1000 kWhEstimated monthly usage assumption for pricing.
PlanPlan Fuel TypePLAN_FUEL_TYPEElectricityEnergy fuel type (Electricity, Gas, etc.).
PlanPlan LengthPLAN_LENGTH12Plan length in months.
PlanPlan MarketPLAN_MARKETERCOTMarket or ISO where plan is active.
PlanPlan NamePLAN_NAMETexas Saver 12Internal plan name.
PlanPlan Start DatePLAN_START_DATE2025-09-01Effective start date of the plan.
PlanPlan TypePLAN_TYPEFixedType of plan (Fixed, Variable, Indexed, etc.).
PlanARP Billing System Plan CodeARP_BILLING_SYSTEM_PLAN_CODEARP-FIX12Code for the plan in the ARP billing system.
PlanARP Cancellation FeeARP_ETF$150Early termination fee amount from ARP data.
PlanARP Date CreatedARP_DATE_CREATED2025-01-01Date when the ARP plan was created.
PlanARP Monthly FeeARP_MONTHLY_FEE$9.95Monthly fee from ARP plan details.
PlanARP Rate CentsARP_RATE_CENTS11.25ARP plan rate expressed in cents.
PlanARP Rate DollarsARP_RATE_DOLLARS0.1125ARP plan rate expressed in dollars.
PlanARP VersionARP_VERSIONv3Version number of the ARP plan record.
PlanCancellation FeePLAN_ETF$200Standard early termination fee for the plan.
PlanCommodity TypeARP_COMMODITYGasCommodity type according to ARP.
PlanDefault Plan Cancellation FeePLAN_DEFAULT_PLAN_ETF$100Default cancellation fee applied if not otherwise specified.
PlanDefault Plan Monthly FeePLAN_DEFAULT_PLAN_MONTHLY_FEE$6.95Default monthly fee for fallback scenarios.
PlanDefault Plan NamePLAN_DEFAULT_PLAN_NAMEStandard Fixed 12Default internal plan name.
PlanDefault Plan Rate CentsPLAN_DEFAULT_PLAN_RATE_CENTS9.85Default plan rate in cents.
PlanDefault Plan Rate DollarsPLAN_DEFAULT_PLAN_RATE_DOLLARS0.0985Default plan rate in dollars.
PlanDefault Plan TermDEFAULT_PLAN_TERMS_NUM12Default plan term length (in months).
PlanDist. Name DisplayPLANTXUDisplay name of distributor for this plan.
PlanDist. Name Display (ARP)ARP_NAMEARP Texas FixedARP-provided plan display name.
PlanDocument VersionDOC_VERSIONv2.1Version number of plan-related documentation.
PlanEarly Term TextEARLY_TERM_TEXTEarly exit fee $200Text describing the early termination policy.
PlanESG Plan CodeESG_PLAN_CODEESG-TX-2025-FIXPlan code as registered with ESG system.
PlanFuture Enrollment Available FromPLAN_FUTURE_ENROLLMENT_FROM2025-10-01Start date when future enrollments will be allowed.
PlanFuture Enrollment Available UntilPLAN_FUTURE_ENROLLMENT_UNTIL2026-01-01End date for future enrollment availability.
PlanInterval Assumed Consumption PercentageINTERVAL_ASSUMED_CONSUMPTION_PERCENTAGE75%Assumed consumption percentage for interval-based plans.
PlanInterval Rate CentsINTERVAL_RATE_CENTS13.2Interval-based rate in cents.
PlanInterval Rate DollarsINTERVAL_RATE_DOLLARS0.132Interval-based rate in dollars.
PlanMonthly FeePLAN_MONTHLY_FEE$8.95Monthly administrative/service fee for the plan.
PlanPlan Date CreatedPLAN_DATE_CREATED2025-06-15Date when the plan was created in OpsAdmin.
PlanPlan DescriptionPLAN_DESCRIPTIONTexas Fixed 12 mo.Internal description of the plan.
PlanPlan Description (ARP)ARP_DESCRIPTIONARP TX 12 FixedPlan description from ARP.
PlanPlan Effective DatesPLAN_EFFCTIVE_DATES2025-09-01 to 2026-09-01Range of effective dates for the plan.
PlanPlan ETF Warning TextPLAN_ETF_WARNING_TEXTETF applies if…Warning text shown for ETF disclosures.
PlanPlan Future Cancellation FeePLAN_FUTURE_ETF$120Future-dated cancellation fee.
PlanPlan Future Effective DatesPLAN_FUTURE_EFFECTIVE_DATES2026-01-01 to 2027-01-01Future plan effective dates.
PlanPlan Future Monthly FeePLAN_FUTURE_MONTHLY_FEE$7.50Future-dated monthly fee.
PlanPlan Future Rate CentsPLAN_FUTURE_RATE_CENTS10.5Future-dated plan rate in cents.
PlanPlan Future Rate DollarsPLAN_FUTURE_RATE_DOLLARS0.105Future-dated plan rate in dollars.
PlanPlan Information TextPLAN_INFORMATION_TEXTAdditional info…Custom information text for plan documents.
PlanPlan Information Text (ARP)ARP_INFORMATION_TEXTARP disclaimer…ARP-provided plan information text.
PlanPlan Initial Discount PercentagePLAN_INITIAL_DISCOUNT_PERCENTAGE10%Initial discount percentage offered.
PlanPlan Initial Discount PeriodPLAN_INITIAL_DISCOUNT_PERIOD3 monthsPeriod during which initial discount applies.
PlanPlan Initial Discount Rate CentsPLAN_INITIAL_DISCOUNT_RATE_CENTS9.5Discounted initial rate in cents.
PlanPlan Initial Discount Rate DollarsPLAN_INITIAL_DISCOUNT_RATE_DOLLARS0.095Discounted initial rate in dollars.
PlanPlan Prior Cancellation FeePLAN_PRIOR_ETF$100Cancellation fee from the prior version of this plan.
PlanPlan Prior Effective DatesPLAN_PRIOR_EFFECTIVE_DATES2024-09-01 to 2025-09-01Effective dates of the prior version.
PlanPlan Prior Monthly FeePLAN_PRIOR_MONTHLY_FEE$6.50Monthly fee from prior version of the plan.
PlanPlan Prior Rate CentsPLAN_PRIOR_RATE_CENTS8.9Rate from the prior version (in cents).
PlanPlan Prior Rate DollarsPLAN_PRIOR_RATE_DOLLARS0.089Rate from the prior version (in dollars).
PlanPlan Reassing DatePLAN_REASSIGN_DATE2025-09-01Date when the plan was reassigned/updated.
PlanPlan SubtypePLAN_SUBTYPEIndexedSub-classification of the plan.
PlanPlan VersionPLAN_VERSIONv4Version number of the plan.
PlanPrevious Enrollment Traunch 1000PREVIOUS_ENROLLMENT_TRAUNCH_10001000 kWhUsage tier (traunch) from prior enrollment.
PlanPrevious Enrollment Traunch 1500PREVIOUS_ENROLLMENT_TRAUNCH_15001500 kWhUsage tier (traunch) from prior enrollment.
PlanPrevious Enrollment Traunch 500PREVIOUS_ENROLLMENT_TRAUNCH_500500 kWhUsage tier (traunch) from prior enrollment.
PlanPrevious Plan ETFPREVIOUS_PLAN_ETF$75ETF value from previous plan.
PlanPrevious Plan Monthly FeePREVIOUS_PLAN_MONTHLY_FEE$4.95Monthly fee from previous plan.
PlanPrevious Plan NamePREVIOUS_PLAN_NAMELegacy Fixed 6Name of the previous plan.
PlanPrevious Plan Rate CentsPREVIOUS_PLAN_RATE_CENTS7.8Rate of the previous plan in cents.
PlanPrevious Plan Rate DollarsPREVIOUS_PLAN_RATE_DOLLARS0.078Rate of the previous plan in dollars.
PlanPrevious Plan TermsPREVIOUS_PLAN_TERMS6 monthsContract terms of the previous plan.
PlanPrevious Plan Terms NumPREVIOUS_PLAN_TERMS_NUM6Numeric contract length of the previous plan.
PlanRenewable Percent of CommoditiesPLAN_COMMODITY_RENEWABLE_PERCENT20%Portion of energy sourced from renewables.
PlanTerm TextARP_TERMS12-month fixedTerm description text from ARP.
PlanTerm Unit AmountARP_TERMS_NUM12Numeric plan term length from ARP.
PlanTime Of Use IntervalsTIME_OF_USE_INTERVALSPeak/Off-PeakDefined time-of-use intervals for pricing.
PlanTraunch 10TRAUNCH_1010 kWhTraunch usage tier at 10 kWh.
PlanTraunch 20TRAUNCH_2020 kWhTraunch usage tier at 20 kWh.
PlanTraunch 30TRAUNCH_3030 kWhTraunch usage tier at 30 kWh.
PlanTraunch 40TRAUNCH_4040 kWhTraunch usage tier at 40 kWh.
PlanTraunch 75TRAUNCH_7575 kWhTraunch usage tier at 75 kWh.
PlanTraunch 30000TRAUNCH_3000030,000 kWhTraunch usage tier at 30,000 kWh.
PlanTraunch 40000TRAUNCH_4000040,000 kWhTraunch usage tier at 40,000 kWh.
Pricing MatrixBase RatePRICING_BASE_RATE0.105The base energy rate before margins/fees.
Pricing MatrixEarly Termination FeePRICING_ETF$150Early termination fee amount.
Pricing MatrixMinimum Usage FeePRICING_MINIMUM_USAGE_FEE$9.95Fee applied if usage is below minimum threshold.
Pricing MatrixMonthly Service FeePRICING_MONTHLY_SERVICE_FEE$4.95Monthly administrative/service fee.
Pricing MatrixRate ClassPRICING_RATE_CLASSRESUtility rate class (Residential, Commercial, etc.).
Pricing MatrixRate SubclassPRICING_RATE_SUBCLASSR1Subclass of the utility rate.
Pricing MatrixUnit of MeasurePRICING_UOMkWhUnit of measure for billing.
Pricing MatrixCustom MessageCUSTOM_MESSAGE"Special weekend promo"Custom text field for messages tied to pricing templates.
Pricing MatrixPricing Matrix Mail MessagePRICING_MATRIX_MAIL_MESSAGE"Your new rate is live!"Email/letter text generated from pricing matrix actions.
ProspectProspect AddressPROSPECT_ADDRESS123 Prospect LnProspect’s mailing address.
ProspectProspect CityPROSPECT_CITYAustinProspect’s city.
ProspectProspect EmailPROSPECT_EMAILprospect@mail.comProspect email address.
ProspectProspect First NamePROSPECT_FIRST_NAMESarahProspect’s first name.
ProspectProspect Full NamePROSPECT_FULL_NAMESarah ConnorProspect’s full name.
ProspectProspect Last NamePROSPECT_LAST_NAMEConnorProspect’s last name.
ProspectProspect Phone NumberPROSPECT_PHONE_NUMBER737-555-4455Prospect’s phone number.
ProspectProspect StatePROSPECT_STATETXProspect’s state.
ProspectProspect ZipPROSPECT_ZIP73301Prospect’s ZIP code.
ProspectAffiliate Commission RatePROSPECT_AFFILIATE_COMMISSION_RATE0.02Commission rate applied to the affiliate.
ProspectAffiliate Commission Split (cents)PROSPECT_AFFILIATE_COMMISSION_SPLIT_CENTS50Affiliate commission share in cents.
ProspectAffiliate Commission Split (dollars)PROSPECT_AFFILIATE_COMMISSION_SPLIT_DOLLARS0.50Affiliate commission share in dollars.
ProspectAffiliate Reference IdPROSPECT_AFFILIATE_REFERENCE_IDAFF-2025-01Reference ID used by the affiliate.
ProspectAgent NamePROSPECT_AGENT_NAMEJohn SalesSales agent name tied to the prospect.
ProspectAnnual UsagePROSPECT_ANNUAL_USAGE12,000 kWhExpected annual energy usage for the prospect.
ProspectCommodityPROSPECT_COMMODITYElectricityCommodity type for the prospect (Gas/Electricity).
ProspectCreated atCREATED_AT2025-08-01Timestamp when the prospect record was created.
ProspectExpiration DatePROSPECT_EXPIRATION_DATE2025-12-31Date when the quoted rate/offer expires.
ProspectLdcPROSPECT_LDCPPLLocal Distribution Company linked to the prospect.
ProspectMeter NumberPROSPECT_METER_NUMBER987654321Utility meter number for the prospect.
ProspectModified atMODIFIED_AT2025-08-20Timestamp when the record was last updated.
ProspectPrice (cents)PROSPECT_PRICE_CENTS12.4Price for the prospect in cents.
ProspectPrice (dollars)PROSPECT_PRICE_DOLLARS0.124Price for the prospect in dollars.
ProspectPrice File DatePROSPECT_PRICE_FILE_DATE2025-08-15Date of the source price file.
ProspectPrice Provider Utility CodePROSPECT_PRICE_PROVIDER_UTILITY_CODEPPL-2025Utility code from the price provider.
ProspectRate (cents)PROSPECT_RATE_CENTS11.8Rate offered to the prospect in cents.
ProspectRate (dollars)PROSPECT_RATE_DOLLARS0.118Rate offered to the prospect in dollars.
ProspectRate CodePROSPECT_RATE_CODEFIXED12Internal rate code for the prospect’s plan.
ProspectRejection ReasonPROSPECT_REJECTION_REASONCredit DeclinedReason the prospect was rejected.
ProspectRep Commission Split (cents)PROSPECT_REP_COMMISSION_SPLIT_CENTS75Representative’s commission share in cents.
ProspectRep Commission Split (dollars)PROSPECT_REP_COMMISSION_SPLIT_DOLLARS0.75Representative’s commission share in dollars.
ProspectRep Reference IdPROSPECT_REP_REFERENCE_IDREP-7781Reference ID for the representative.
ProspectService Account ListPROSPECT_SERVICE_ACCOUNTSACC-1001, ACC-1002List of service accounts linked to the prospect.
ProspectStart DatePROSPECT_START_DATE2025-09-01Start date of service for the prospect.
ProspectStatusPROSPECT_STATUSPendingCurrent status of the prospect record.
ProspectTermPROSPECT_TERM12 monthsContract term offered to the prospect.
ProspectUsage TierPROSPECT_USAGE_TIERTier 1Usage tier classification for the prospect.
ProspectZonePROSPECT_ZONENorth ZoneUtility or pricing zone tied to the prospect.